pp108 : MDM Data Entity Interface

MDM Data Entity Interface

This topic describes the various fields on the MDM data entity interface.


The MDM data entity interface helps filling the fields on the MDM data entity interface.   

Table 1. Other Fields on the MDM Data Entity Interface

Field Description
Name Specify name of the data entity.
Description Provide description for the data entity.
Entity Type

The options of the Entity Type describe use of entity regarding the flow of data to and from it. Select any one of the following entity types:

  • Send and Receive Data: To send and receive data between the hub and the spoke entities. This option is selected, by default.
  • Send Data only: To send data only
  • Receive Data only: To receive data only
    Note: Send and Receive Data is the only option for a hub data entity.
Business Object Lifecycle Enable Business Object Lifecycle is enabled by default, this option is used to manage the life cycle of a business object. For simple synchronization, clear this check box, the Sniffer tab appears in place of Business Object Lifecycle.
Note: The Enable Business Object Lifecycle check box appears only for a hub data entity.
Business Object

Each business object is represented as a schema fragment in the Process Platform environment on which the rest of the modeling activities are based. For example, business object is the basis for defining data transformation, business rules and so on.Perform the following steps to select a business object:

  1. Click corresponding to Business Object. The Select a Schema Fragment Object dialog box appears.
  2. Select the schema fragment object. The selected schema fragment object appears in the text box corresponding to Selected Document, and the OK button is enabled.
  3. Click the OK button. The selected schema fragment appears in the Business Object text box.
  4. Click (Select Keys) button to select the field(s) as primary key(s). The Select Key Fields dialog appears with a list of fields.
  5. Select the check box(es) corresponding to the field(s) under Key column as the primary key(s) so that MDM can uniquely identify an instance of the selected schema fragment object.
  6. Click Select the Data Type under the Data Type column for the check box(es) that you have selected under the Key column to view the drop-down(s). The data type drop-down appears with the list of data types under Data Type column.
  7. Select the relevant data type and click the OK button.



Table 2. Fields on the Business Object Lifecycle tab

Field Description
State Model A State model is a graphical depiction of the life cycle management model defined for the hub entity.Specify a state model. Clicking , displays a list of state models that were already created. For information on designing state models, refer to Designing a State Model.
Event Triggers

Triggers or events are the communication channels with which the behavior of a state model is controlled. Inside a state model, you can model to control the behavior of the object reacting to different events leading to different execution paths.Select the trigger type that you have specified while Designing a State Model:

  • Insert Trigger: When a record at Spoke entity is inserted, it enters the first state of the State Engine. If this record already exists in the State Engine, select the event name using which this record moves to another state of the State Model from the current state.
  • Update Trigger: When a record at Spoke entity is updated, select the event name using which this record moves to another state of the State Model from the current state. If this record does not exist in the State Engine, then it enters the first state of the State Model.
  • Delete Trigger: When a record at Spoke entity is deleted, select the event name using which this record moves to another state of the State Model from the current state. If this record does not exist in the State Engine, then it enters the first state of the State Model.
Enable Registry A registry is a collection of entries. In MDM context, a registry holds a collection of links that point to the corresponding records in different systems for a master data record.Select the Enable Registry check box to enable registry. The ID Generator appears on selecting the check box. Click , next to ID Generator. The Select a sequence generator dialog box appears. Select the relevant Sequence Generator that is already created. The Sequence Generator dialog box appears if you have selected a default Sequence Generator. For information on the fields on the Sequence Generator, refer to Fields on Sequence Generator Properties Interface. If you have selected a customized Sequence Generator, the property sheet appears with the properties that you have specified. You may edit the properties, if you want.
Enable Data Quality

Data quality is the process of refining quality of master data that enters the hub. You can expect pure (without any duplicates) and accurate master data with data quality tool in MDM.Select the Enable Data Quality check box to enable data quality. The Data Quality tab along with the following fields appear on selecting the check box:

  • Data Quality Plan: You may select the data quality plan that is already created or create a new Data quality plan.
    Note: Select a data quality plan if you have to configure a hub entity to make use of a third party data quality management tool and if you have to integrate the third party data quality management tool with MDM.
  • Match Object Life Cycle: Select a state model using . Select the state model for the candidate object's life cycle, if the selected data quality plan has a Match operation defined and if it returns a set of candidate objects as a response to this operation. Each of the candidate object undergoes the life cycle of the selected state model.
  • Match Object Table Name: Type the table name that saves details of the candidate object changes for a business object. This is visible in Advanced tab.



Table 3. Fields on the Web Services tab

Field Description
Web Service Type

In the MDM synchronization model, the data integration frameworks work with Web services to communicate with different systems. The type of Web service indicates whether the Web service is an in-house Process Platform Web service or an externally hosted Web service.Select any one of the following Web Service types for data synchronization:

  • Transactional: If you have a transactional Web service that conforms to the Process Platform standard protocol
    Note: The Transactional option is selected for a hub entity, by default, and the Non-Transactional (External Web Service, etc) option is disabled.
  • Non-Transactional (External Web Service, etc): If you have a non-transactional Web service that does not conform to the Process Platform standard protocol
    Note: The Web Service Transformations tab appears on selecting the Non-Transactional (External Web Service, etc) option.
Use Generic Update Web Service

A generic update service can perform all the operations on a business object (insert, update and delete). Select the Use Generic Update Web Service check box to perform Insert, Modify and Delete operations using a single Web service, such as the 'Update' and 'UpdateBusinessObject' Web services generated in Process Platform over database tables. Clear the check box to select 3 distinct Web services to insert, modify and delete data. You can select the Web services to read data on the Read tab, and select the Web service to update data on the Modify tab.
Note:

  1. The Use Generic Update Web Service check box is selected by default, on selecting the Transactional option and is disabled on selecting the Non-Transactional (External Web Service, etc) type of Web service.
  2. The Use Generic Update Web Service check box does not appear if you choose Send Data only option of the Entity Type while creating a data entity.
Read tab Click Read tab to select a Web service to read data and to specify Web service request parameters.
Modify tab Click Modify tab to select a Web service to update data.
Web Service Transformations tab Each Web service expects the input parameters in a specific structure as defined in the WSDL. You have to map the business object to the input structure of the Web service using data transformations.Click Web Service Transformations tab to specify the Read, Update, Insert and Delete transformations to transform the non-transactional Web service into a Transactional Web service that conforms to the Process Platform standard protocol.
Note: The Web Service Transformations tab appears only if you choose the Non-Transactional (External Web Service, etc) option of the Entity Type while creating a data entity.



Table 4. Fields on the Sniffer tab

Field Description
Sniffer Type

Sniffers are components in data integration framework of MDM. Sniffers capture the changes that occur in the source system and publish the same to the subscribing clients. Select any one of the following sniffers:

  • Default - to select any one of the default sniffers that Process Platform provides. The Default Sniffer along with a drop-down list appears.
  • Custom: to specify the sniffer that you have already configured. The Custom Sniffer appears along with .
    Note: Hub data entity is configured to Trigger Sniffer.
Default Sniffer Select one of the default sniffers that Process Platform provides. Refer to Fields of MDM Default Sniffers for more information on the properties and fields of the default sniffers.
Custom Sniffer Perform the following steps to specify the sniffer:
1.Click . The Select a sniffer dialog box appears.
2.Select the sniffer if you have already created or create a Custom MDM Sniffer.
3.Click OK.
Note: The fields for a custom sniffer depend upon the parameters that you have defined.
Enable Schedule For Sniffer There may be business needs where you have to synchronize data real-time or at right time (scheduled). For certain business needs, it is mandatory that you should synchronize data after business hours. Hence, you can use scheduling option to meet the purpose.Select the check box if you want to watch the changes at regular intervals. The Schedule Details tab appears. Refer to Fields in Sniffer Schedule for information on fields on the Schedule Details tab.
Note: Configuring the Schedule Details tab is optional for all sniffer types except the Comparator sniffer.



Table 5. Fields on the Advanced tab

Field Description
Read Web Service Cursor Read Web service reads data from the source system. The database may contain lots (millions) of data. In such cases, data integration framework should pull this data in smaller batches so as to process them in chunks. You can configure the batch size.Type the number of records you have to fetch to read data in the text box next to Read Web Service Cursor.
Note: The Read Web Service Cursor appears only when you select the Use Generic Update Web Service check box. The value for the Read Web Service Cursor appears as 1000, by default. You may change the number of records to be fetched depending upon the requirement.
Update Web Service Batch Size Update Web service updates data from the source system. The database may contain lots (millions) of data. In such cases, data integration framework should pull this data in smaller batches so as to process them in chunks. You can configure the batch size. Type the number of records you have to fetch to update data in the text box next to Update Web Service Batch Size.
Note: The Update Web Service Batch Size appears only when you select the Use Generic Update Web Service check box. The value for the Update Web Service Batch Size appears as 1000, by default. You may change the number of records to be fetched depending upon the requirement.
Insert Web Service Batch Size Insert Web service inserts data from the source system. The database may contain lots (millions) of data. In such cases, data integration framework should pull this data in smaller batches so as to process them in chunks. You can configure the batch size.Type the number of records you have to fetch to insert data in the text box next to Insert Web Service Batch Size.
Note: The Insert Web Service Batch Size appears only for a spoke data entity. The value for the Insert Web Service Batch Size appears as 1000, by default. You may change the number of records to be fetched depending upon the requirement.
Delete Web Service Batch Size Delete Web service deletes data from the source system. The database may contain lots (millions) of data. In such cases, data integration framework should pull this data in smaller batches so as to process them in chunks. You can configure the batch size.Type the number of records you have to fetch to insert data in the text box next to Delete Web Service Batch Size.
Note: The Delete Web Service Batch Size appears only for a spoke data entity. The value for the Delete Web Service Batch Size appears as 1000, by default. You may change the number of records to be fetched depending upon the requirement.
Sniffer Audit Table Name Sniffers work with an audit table. Every sniffer in the synchronization framework dumps the changes into the audit table for further asynchronous processing.The database table name that stores all the audit information appears, by default.
State Instance Table Name State management or life cycle management of the master data object is done in a staging area, which is different from the final master data repository where this object has to be updated. State instance table is the staging area for this hub object.The database table name, which you have specified appears in the Advanced tab by default. The database table saves the details of state changes for a business object.
Note: The State Instance Table Name appears only for a hub data entity.
Registry Table Name Registry is a collection of cross linkages of master data records. These linkages are stored inside this table (registry table).Specify a name for the database table, that stores the registry details.
Note: The Registry Table Name appears in the Advanced tab only if you have selected Enable Registry check box for a hub data entity.
Match Object Table Name In life cycle management of master data object, the data steward has to deal with duplicate objects that match the incoming object. Data steward, sometimes, has to manually resolve these data conflicts and accept the incoming record as distinct or mark it as duplicate. This table is the repository to hold such match objects.Type the table name that saves details of the candidate object changes for a business object.
Note: The Match Object Table Name appears in the Advanced tab only if you have selected Enable Data Quality check box for a hub data entity.